Android Scanbot SDK/io.scanbot.sdk.ui_v2.document.screen.documentcleanup

Package-level declarations

Types

interface DocumentCleanupActionController

Controller exposing the available actions for an active DocumentCleanupCustomUIInternal (or its public wrapper) instance. The instance is provided through onActionControllerCreated and can be used to wire custom UI buttons (undo/redo/reset), to observe undo/redo availability and to retrieve the currently displayed cleanup image.

DocumentCleanupCustomUiViewModel

class DocumentCleanupCustomUiViewModel(backgroundDispatcher: CoroutineContext, documentCleanupProvider: IDocumentCleanupFactory) : DocumentCleanupActionController

DocumentCleanupViewModel

class DocumentCleanupViewModel(val config: DocumentCleanupScreenConfiguration, val toolbarBackground: ScanbotColor, val topBarBackground: ScanbotColor, scanSession: IDocumentCleanupViewModel, val documentCleanupFactory: IDocumentCleanupFactory, val backgroundDispatcher: CoroutineContext, val ioDispatcher: CoroutineContext, arguments: Bundle) : ICanGoBack, ICleanupIntroductionAware

IDocumentCleanupViewModel

interface IDocumentCleanupViewModel : IDocumentHolder, ICanGoBack, ICleanupIntroductionAware

Functions

DocumentCleanupCustomUIInternal

fun DocumentCleanupCustomUIInternal(viewModel: DocumentCleanupCustomUiViewModel, modifier: <Error class: unknown class> = Modifier, backgroundColor: <Error class: unknown class> = Color.Black, brushSize: <Error class: unknown class> = 40.dp, brushColor: <Error class: unknown class> = Color.Red, maxZoomScale: Float = DocConstants.maxZoomScale, onActionControllerCreated: (DocumentCleanupActionController) -> Unit = {})

Internal composable rendering the mask-drawable cleanup canvas backed by a DocumentCleanup instance produced via documentCleanupProvider.

DocumentCleanupIntroductionDialog

fun DocumentCleanupIntroductionDialog(showIntroDialog: <Error class: unknown class><Boolean>, config: DocumentCleanupIntroductionScreenConfiguration, onIntroDialogDismiss: () -> Unit)

DocumentCleanupScreen

fun DocumentCleanupScreen(modifier: <Error class: unknown class> = Modifier, viewModel: DocumentCleanupViewModel, paddingValues: <Error class: unknown class> = PaddingValues())